/*
 * Package il.ac.biu.cs.grossmm.api.presence
 * File BaseVocabulary.java
 * 
 * This is a part of presence service framework API. 
 * See javadoc for more information.
 *  
 * Copyright (C) 2006 Grossmann Mark
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
 * MA  02110-1301, USA.
 */

package il.ac.biu.cs.grossmm.api.presence;

import il.ac.biu.cs.grossmm.api.keys.Attribute;

/**
 * Representce a base vocabulary to define semantics of data keys
 */
public enum BaseVocabulary implements Attribute {
	/**
	 * Refers to a presentity, the value should be an Entity of type presentity.
	 */
	PRESENTITY,

	/**
	 * Refers to a watcher, the value should be an Entity of type watcher.
	 */
	WATCHER,
	
	/**
	 * The document to which refers the attribute of grandparent key
	 * is a virtual resource whose key is the parent key with this
	 * attribute removed. 
	 */
	REFERENCE,

	/**
	 * Refers to a filter document.
	 */
	FILTER,

	/**
	 * Refers to a type of a resource. The value of associated key should be of
	 * type <tt>ResourceType</tt>.
	 */
	RESOURCE_TYPE,

	/**
	 * Refers to a content type of a document. Subkeys of associated key contain
	 * representations of content_type as well as modifiers such as
	 * <tt>ENCODING</tt>.
	 */
	CONTENT_TYPE,

	/**
	 * Refers to the default encoding of a document. The value of associated
	 * subkey should contain a string representation of the encoding such as
	 * "utf-8" or "cp-1251".
	 */
	ENCODING;
}
